<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package net.jmatrix.eproperties.include;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.*;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    import net.jmatrix.eproperties.*;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    import org.apache.commons.logging.*;<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    /** <a name="line.10"></a>
<FONT color="green">011</FONT>     * Processes include URLs for the parser.  This contains a pluggable<a name="line.11"></a>
<FONT color="green">012</FONT>     * loader implementation for various URL formats.  <a name="line.12"></a>
<FONT color="green">013</FONT>     */<a name="line.13"></a>
<FONT color="green">014</FONT>    public class EPropertiesIncluder {<a name="line.14"></a>
<FONT color="green">015</FONT>       static Log log=LogFactory.getLog(EPropertiesIncluder.class);<a name="line.15"></a>
<FONT color="green">016</FONT>       List&lt;PropertiesLoader&gt; loaders=new ArrayList&lt;PropertiesLoader&gt;();<a name="line.16"></a>
<FONT color="green">017</FONT>       <a name="line.17"></a>
<FONT color="green">018</FONT>       PropertiesLoader urlPropsLoader=null;<a name="line.18"></a>
<FONT color="green">019</FONT>       <a name="line.19"></a>
<FONT color="green">020</FONT>       public static boolean debug=false;<a name="line.20"></a>
<FONT color="green">021</FONT>       <a name="line.21"></a>
<FONT color="green">022</FONT>       public EPropertiesIncluder() {<a name="line.22"></a>
<FONT color="green">023</FONT>          urlPropsLoader=new URLPropertiesLoader(); <a name="line.23"></a>
<FONT color="green">024</FONT>          <a name="line.24"></a>
<FONT color="green">025</FONT>          registerLoader(urlPropsLoader);<a name="line.25"></a>
<FONT color="green">026</FONT>          //registerLoader(new SystemPropertiesLoader());<a name="line.26"></a>
<FONT color="green">027</FONT>          registerLoader(new MethodPropertiesLoader());<a name="line.27"></a>
<FONT color="green">028</FONT>       }<a name="line.28"></a>
<FONT color="green">029</FONT>       <a name="line.29"></a>
<FONT color="green">030</FONT>       /** */<a name="line.30"></a>
<FONT color="green">031</FONT>       public void registerLoader(PropertiesLoader upl) {<a name="line.31"></a>
<FONT color="green">032</FONT>          log.debug("Registering loader "+upl.getClass().getName());<a name="line.32"></a>
<FONT color="green">033</FONT>          loaders.add(upl);<a name="line.33"></a>
<FONT color="green">034</FONT>       }<a name="line.34"></a>
<FONT color="green">035</FONT>       <a name="line.35"></a>
<FONT color="green">036</FONT>       /**<a name="line.36"></a>
<FONT color="green">037</FONT>        * Processes an include, typically on behalf of the parser.<a name="line.37"></a>
<FONT color="green">038</FONT>        */<a name="line.38"></a>
<FONT color="green">039</FONT>       public Object processInclude(EProperties parent, String url) {<a name="line.39"></a>
<FONT color="green">040</FONT>          // Include URL format and options are the following:<a name="line.40"></a>
<FONT color="green">041</FONT>          // [prefix://]path;[options]<a name="line.41"></a>
<FONT color="green">042</FONT>          // if [prefix://] is omitted, then it is assumed that this<a name="line.42"></a>
<FONT color="green">043</FONT>          // is a file based inclusion.  (this would be the most <a name="line.43"></a>
<FONT color="green">044</FONT>          // common).  If the file begins with a '/', then its path<a name="line.44"></a>
<FONT color="green">045</FONT>          // is assumed to be absolute.  Otherwise, it is assumed<a name="line.45"></a>
<FONT color="green">046</FONT>          // to be relative to its parent.  <a name="line.46"></a>
<FONT color="green">047</FONT>          // file:// URLs can also be used. <a name="line.47"></a>
<FONT color="green">048</FONT>          <a name="line.48"></a>
<FONT color="green">049</FONT>          <a name="line.49"></a>
<FONT color="green">050</FONT>          // the URL string will come in as [include.properties]<a name="line.50"></a>
<FONT color="green">051</FONT>          url=url.trim();<a name="line.51"></a>
<FONT color="green">052</FONT>          if (url.startsWith("["))<a name="line.52"></a>
<FONT color="green">053</FONT>             url=url.substring(1, url.length());<a name="line.53"></a>
<FONT color="green">054</FONT>          if (url.endsWith("]"))<a name="line.54"></a>
<FONT color="green">055</FONT>             url=url.substring(0, url.length()-1);<a name="line.55"></a>
<FONT color="green">056</FONT>          <a name="line.56"></a>
<FONT color="green">057</FONT>          // Here, we handle the potential for tokenization of the inclusion <a name="line.57"></a>
<FONT color="green">058</FONT>          // URL.  If the token cannot be found, this will throw a <a name="line.58"></a>
<FONT color="green">059</FONT>          // InvalidIndirectionException()<a name="line.59"></a>
<FONT color="green">060</FONT>          // this is new as of 16 feb 2009.<a name="line.60"></a>
<FONT color="green">061</FONT>          //System.out.println ("Parent properties: "+parent);<a name="line.61"></a>
<FONT color="green">062</FONT>          // parent.list(System.out);<a name="line.62"></a>
<FONT color="green">063</FONT>          if (SubstitutionProcessor.containsTokens(url))<a name="line.63"></a>
<FONT color="green">064</FONT>          url=SubstitutionProcessor.processSubstitution(url, parent);<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>          // if it still contains tokens, that's an error (substitution failed).<a name="line.66"></a>
<FONT color="green">067</FONT>          if (SubstitutionProcessor.containsTokens(url)) {<a name="line.67"></a>
<FONT color="green">068</FONT>             log.error("Warning: Include URL '"+url+"' defined "+<a name="line.68"></a>
<FONT color="green">069</FONT>                       "in terms of un-resolvable substitution.");<a name="line.69"></a>
<FONT color="green">070</FONT>          }<a name="line.70"></a>
<FONT color="green">071</FONT>          <a name="line.71"></a>
<FONT color="green">072</FONT>          // process options<a name="line.72"></a>
<FONT color="green">073</FONT>          EProperties options=parseOptionsFromIncludeURL(url);<a name="line.73"></a>
<FONT color="green">074</FONT>          if (options.size() &gt; 0) {<a name="line.74"></a>
<FONT color="green">075</FONT>             // trim the options off the end of that url<a name="line.75"></a>
<FONT color="green">076</FONT>             url=url.substring(0, url.indexOf("|"));<a name="line.76"></a>
<FONT color="green">077</FONT>          }<a name="line.77"></a>
<FONT color="green">078</FONT>          <a name="line.78"></a>
<FONT color="green">079</FONT>          <a name="line.79"></a>
<FONT color="green">080</FONT>          int size=loaders.size();<a name="line.80"></a>
<FONT color="green">081</FONT>          for (int i=0; i&lt;size; i++) {<a name="line.81"></a>
<FONT color="green">082</FONT>             PropertiesLoader upl=loaders.get(i);<a name="line.82"></a>
<FONT color="green">083</FONT>             if (upl.acceptsURL(url)) {<a name="line.83"></a>
<FONT color="green">084</FONT>                log.debug("Processing include with "+<a name="line.84"></a>
<FONT color="green">085</FONT>                     upl.getClass().getName());<a name="line.85"></a>
<FONT color="green">086</FONT>                <a name="line.86"></a>
<FONT color="green">087</FONT>                Object result=upl.loadProperties(parent, url, options);<a name="line.87"></a>
<FONT color="green">088</FONT>                //EProperties props=upl.loadProperties(parent, url, options);<a name="line.88"></a>
<FONT color="green">089</FONT>                <a name="line.89"></a>
<FONT color="green">090</FONT>                if (result instanceof EProperties) {<a name="line.90"></a>
<FONT color="green">091</FONT>                   ((EProperties)result).setIncludedURL(url);<a name="line.91"></a>
<FONT color="green">092</FONT>                }<a name="line.92"></a>
<FONT color="green">093</FONT>                return result;<a name="line.93"></a>
<FONT color="green">094</FONT>             }<a name="line.94"></a>
<FONT color="green">095</FONT>          }<a name="line.95"></a>
<FONT color="green">096</FONT>          log.debug("Hmmm... No PropertiesLoader accepts url '"+url+"'");<a name="line.96"></a>
<FONT color="green">097</FONT>          log.debug ("       Assuming URLPropertiesLoader.");<a name="line.97"></a>
<FONT color="green">098</FONT>          // if no one else claims it, assume that this URL does not <a name="line.98"></a>
<FONT color="green">099</FONT>          // start with foo://, and assume that it is a relative URL<a name="line.99"></a>
<FONT color="green">100</FONT>          //EProperties props=urlPropsLoader.loadProperties(parent, url, options);<a name="line.100"></a>
<FONT color="green">101</FONT>          //props.setIncludedURL(url);<a name="line.101"></a>
<FONT color="green">102</FONT>          <a name="line.102"></a>
<FONT color="green">103</FONT>          Object result=urlPropsLoader.loadProperties(parent, url, options);<a name="line.103"></a>
<FONT color="green">104</FONT>          <a name="line.104"></a>
<FONT color="green">105</FONT>          if (result instanceof EProperties) {<a name="line.105"></a>
<FONT color="green">106</FONT>             ((EProperties)result).setIncludedURL(url);<a name="line.106"></a>
<FONT color="green">107</FONT>          }<a name="line.107"></a>
<FONT color="green">108</FONT>          return result;<a name="line.108"></a>
<FONT color="green">109</FONT>       }<a name="line.109"></a>
<FONT color="green">110</FONT>       <a name="line.110"></a>
<FONT color="green">111</FONT>       /** <a name="line.111"></a>
<FONT color="green">112</FONT>        * Here we are supporting an include options syntax.  All possible<a name="line.112"></a>
<FONT color="green">113</FONT>        * options should have sensible default values in code.  It is up to <a name="line.113"></a>
<FONT color="green">114</FONT>        * each include processor to respect or ignore these options.<a name="line.114"></a>
<FONT color="green">115</FONT>        * <a name="line.115"></a>
<FONT color="green">116</FONT>        * The 2 key options as this point are (defaults in bold):<a name="line.116"></a>
<FONT color="green">117</FONT>        *    parse=[TRUE|false]<a name="line.117"></a>
<FONT color="green">118</FONT>        *    failonerrror=[TRUE|false]<a name="line.118"></a>
<FONT color="green">119</FONT>        *  <a name="line.119"></a>
<FONT color="green">120</FONT>        * The syntax is simple: <a name="line.120"></a>
<FONT color="green">121</FONT>        * <a name="line.121"></a>
<FONT color="green">122</FONT>        * prebill.sql=[sql/prebill.sql|parse=false,failonerror=true]<a name="line.122"></a>
<FONT color="green">123</FONT>        * <a name="line.123"></a>
<FONT color="green">124</FONT>        * Pipe is the delimiter, followed by a csv list of key=value options.<a name="line.124"></a>
<FONT color="green">125</FONT>        * <a name="line.125"></a>
<FONT color="green">126</FONT>        * This could also be used to facilitate JDBC based includes - <a name="line.126"></a>
<FONT color="green">127</FONT>        * with the URL being something like:  <a name="line.127"></a>
<FONT color="green">128</FONT>        *   [jdbc://.......|user=foo,pass=bar,keycol=key,valcol=value]<a name="line.128"></a>
<FONT color="green">129</FONT>        */<a name="line.129"></a>
<FONT color="green">130</FONT>       EProperties parseOptionsFromIncludeURL(String url) {<a name="line.130"></a>
<FONT color="green">131</FONT>          // this can and very often will be an empty set of options.<a name="line.131"></a>
<FONT color="green">132</FONT>          <a name="line.132"></a>
<FONT color="green">133</FONT>          EProperties options=new EProperties();<a name="line.133"></a>
<FONT color="green">134</FONT>          <a name="line.134"></a>
<FONT color="green">135</FONT>          int pipeindex=url.indexOf('|');<a name="line.135"></a>
<FONT color="green">136</FONT>          if (pipeindex &gt; 0) {<a name="line.136"></a>
<FONT color="green">137</FONT>             options.put("original.url", url);<a name="line.137"></a>
<FONT color="green">138</FONT>             String opString=url.substring(pipeindex+1);<a name="line.138"></a>
<FONT color="green">139</FONT>             <a name="line.139"></a>
<FONT color="green">140</FONT>             StringTokenizer st=new StringTokenizer(opString, ",", false);<a name="line.140"></a>
<FONT color="green">141</FONT>             <a name="line.141"></a>
<FONT color="green">142</FONT>             while(st.hasMoreElements()) {<a name="line.142"></a>
<FONT color="green">143</FONT>                String kvp=st.nextToken();<a name="line.143"></a>
<FONT color="green">144</FONT>                <a name="line.144"></a>
<FONT color="green">145</FONT>                int equalsindex=kvp.indexOf("=");<a name="line.145"></a>
<FONT color="green">146</FONT>                if (equalsindex == -1) <a name="line.146"></a>
<FONT color="green">147</FONT>                   options.putBoolean(kvp, true);<a name="line.147"></a>
<FONT color="green">148</FONT>                else {<a name="line.148"></a>
<FONT color="green">149</FONT>                   String key=kvp.substring(0, equalsindex);<a name="line.149"></a>
<FONT color="green">150</FONT>                   String value=kvp.substring(equalsindex+1);<a name="line.150"></a>
<FONT color="green">151</FONT>                   options.put(key, value);<a name="line.151"></a>
<FONT color="green">152</FONT>                }<a name="line.152"></a>
<FONT color="green">153</FONT>             }<a name="line.153"></a>
<FONT color="green">154</FONT>             log.info("Include options: \n"+options.list(2));<a name="line.154"></a>
<FONT color="green">155</FONT>          }<a name="line.155"></a>
<FONT color="green">156</FONT>          <a name="line.156"></a>
<FONT color="green">157</FONT>          return options;<a name="line.157"></a>
<FONT color="green">158</FONT>       }<a name="line.158"></a>
<FONT color="green">159</FONT>    }<a name="line.159"></a>




























































</PRE>
</BODY>
</HTML>
